/*
 * Copyright 2013-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cloud.gateway.filter;

import java.net.URI;

import reactor.core.publisher.Mono;

import org.springframework.cloud.gateway.route.Route;
import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;

import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.isAlreadyRouted;

/**
 * Filter to set the path in the request URI if the {@link Route} URI has the scheme
 * <code>forward</code>.
 * <p>
 *     ForwardPathFilter 是一个实现了 GlobalFilter 和 Ordered 接口的类。
 *     它的主要功能是处理 forward 协议的路由请求，并将请求路径替换为路由目标路径（routeUri.getPath()）。
 *     通过这种方式，Spring Cloud Gateway 可以支持内部转发请求的功能。
 *
 *
 *
 *     主要功能:
 * 			处理 forward 协议的请求。
 * 			将请求路径替换为路由目标路径（routeUri.getPath()）。
 * 			不涉及实际的请求转发操作，仅修改请求路径。
 *
 *
 *
 * 	特性	ForwardPathFilter	ForwardRoutingFilter
 * 主要功能	修改请求路径	实际执行请求转发
 * 协议支持	仅处理 forward 协议	仅处理 forward 协议
 * 优先级	最高优先级（getOrder() == 0）	较低优先级（通常在最后执行）
 * 核心逻辑	修改 ServerWebExchange 的请求路径	使用 DispatcherHandler 执行转发
 * 是否依赖其他组件	不依赖其他组件	依赖 DispatcherHandler
 * 适用场景	路径重写，映射到后端服务	内部请求转发，分发到控制器或处理器
 * </p>
 *
 * @author Ryan Baxter
 */
public class ForwardPathFilter implements GlobalFilter, Ordered {

	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
		Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);
		URI routeUri = route.getUri();
		String scheme = routeUri.getScheme();
		if (isAlreadyRouted(exchange) || !"forward".equals(scheme)) {
			return chain.filter(exchange);
		}
		exchange = exchange.mutate().request(exchange.getRequest().mutate().path(routeUri.getPath()).build()).build();
		return chain.filter(exchange);
	}

	@Override
	public int getOrder() {
		return 0;
	}

}
